Stratastax Entity/dev.buijs.stratastax.entity.core.spi.annotations

Package-level declarations

Types

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class BuildTypeConverter(val target: KClass<*>)

Generates a TypeConverter bean pair between the annotated enum (or sealed interface of data objects) and target: one per direction, mapped member by member.

BuildTypeGenerator

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class BuildTypeGenerator(val source: KClass<*>, val key: String = "")

Generates a TypeGenerator bean for the annotated wrapper type: a class with a single constructor property, such as a @JvmInline value class. The bean wraps every value generated by source.

CsvColumn

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class CsvColumn(val name: String)

Reads this property from the CSV column name instead of the column named after the property.

CsvIgnore

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class CsvIgnore

Leaves this property out of the CSV row; on a DomainEntity, it must have a default value, which the create command then uses.

CsvImport

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class CsvImport

Generates a CsvRowMapper for the annotated class, which reads one CSV row into it.

DomainCreate

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class DomainCreate(val type: KClass<*> = Unit::class, val property: String = "")

Adds this constructor property to the generated create command of its DomainEntity, named Create{Entity}: a plain data class, with no annotations. An entity without such properties has no create command.

DomainCreateGenerated

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class DomainCreateGenerated(val key: String = "")

Marks a constructor property as generated by the application on creation instead of user-supplied.

DomainEntity

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class DomainEntity

Marks a data class as a root entity.

DomainEntityProjection

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class DomainEntityProjection(val entity: KClass<*>)

Marks a data class as a read-only projection of entity, which must be a DomainEntity.

DomainUpdate

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class DomainUpdate(val type: KClass<*> = Unit::class, val property: String = "")

Adds this constructor property to the generated update command of its DomainEntity, named Update{Entity}, as a PatchField that defaults to PatchField.Unset. An entity without such properties has no update command.

DomainUpdateGenerated

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class DomainUpdateGenerated(val key: String = "")

Marks a constructor property as generated by the application on update instead of user-supplied.

OneToManyUpdateStrategy

enum OneToManyUpdateStrategy : Enum<OneToManyUpdateStrategy>

How the child rows of a managed PersistenceJoinMany group are reconciled on update when the collection is supplied (not dev.buijs.stratastax.entity.core.api.PatchField.Unset).

PersistenceColumn

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class PersistenceColumn(val reference: String)

Marks a constructor parameter as backed by a database column.

PersistenceEntity

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class PersistenceEntity(val table: String = "")

Declares the default table of a class so its PersistenceColumn references can omit the table.

PersistenceGenerated

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class PersistenceGenerated

Marks a constructor property as generated by the database on insert instead of user-supplied.

PersistenceId

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class PersistenceId

Marks a constructor property as the identity field of the entity.

PersistenceJoinMany

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class PersistenceJoinMany(val foreignKey: String)

Marks a constructor property as a to-many relation (1:N) through a foreign key of the target.

PersistenceJoinManyThrough

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class PersistenceJoinManyThrough(val foreignKey: String, val targetForeignKey: String)

Marks a constructor property as a to-many relation (M:N) through a junction table.

PersistenceJoinOne

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class PersistenceJoinOne(val foreignKey: String)

Marks a constructor property as a to-one relation (N:1 or 1:1) through a foreign key of this entity.

PersistenceManageChildren

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class PersistenceManageChildren(val updateStrategy: OneToManyUpdateStrategy = OneToManyUpdateStrategy.UPSERT)

Manages the target rows of a relation as owned children: they are created, updated, and deleted together with this entity.

PersistenceManageLinks

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class PersistenceManageLinks

Manages only the relation link, never the target rows.

PersistenceSoftDelete

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class PersistenceSoftDelete

Marks a constructor property as the soft-delete column of the entity.

PersistenceVersion

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class PersistenceVersion

Marks a constructor property as the optimistic-locking version field of the entity.

RestEntity

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class RestEntity(val read: KClass<*> = Unit::class, val readAll: KClass<*> = Unit::class, val create: KClass<*> = Unit::class, val update: KClass<*> = Unit::class)

Declares the REST DTO types of a DomainEntity: the response DTO of one entity (read) and of a page of entities (readAll), and the request DTO of its creation (create) and update (update).

RestProperty

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.PROPERTY])

annotation class RestProperty(val name: String = "", val type: KClass<*> = Unit::class)

The REST DTO property of this property or parameter, when it differs from the domain: in the response DTO and in the request DTOs alike. Without it, a response DTO property has the name of the entity property, and a request DTO property the name of the command property it is written to.

SearchFilter

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class SearchFilter(val alias: String = "")

Marks a constructor property as filterable by the caller.

SearchFixedFilter

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class SearchFixedFilter(val value: String)

Applies an always-on filter property == value that the caller cannot see or override.

SearchSort

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class SearchSort(val tiebreaker: Boolean = false, val direction: SortDirection = SortDirection.ASC)

Marks a constructor property as sortable.